home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmStringGetNextComponent.z / XmStringGetNextComponent
Text File  |  1998-10-30  |  11KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttCCCCoooommmmppppoooonnnneeeennnntttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttCCCCoooommmmppppoooonnnneeeennnntttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttCCCCoooommmmppppoooonnnneeeennnntttt - A compound string function that
  10.           returns the type and value of the next component in a
  11.           compound string
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           #include <Xm/Xm.h>
  15.           XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCoooommmmppppoooonnnneeeennnnttttTTTTyyyyppppeeee XXXXmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttCCCCoooommmmppppoooonnnneeeennnntttt(
  16.           XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCoooonnnntttteeeexxxxtttt ccccoooonnnntttteeeexxxxtttt,
  17.           cccchhhhaaaarrrr ********tttteeeexxxxtttt,
  18.           XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaagggg ****ttttaaaagggg,
  19.           XXXXmmmmSSSSttttrrrriiiinnnnggggDDDDiiiirrrreeeeccccttttiiiioooonnnn ****ddddiiiirrrreeeeccccttttiiiioooonnnn,
  20.           XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCoooommmmppppoooonnnneeeennnnttttTTTTyyyyppppeeee ****uuuunnnnkkkknnnnoooowwwwnnnn____ttttaaaagggg,
  21.           uuuunnnnssssiiiiggggnnnneeeedddd sssshhhhoooorrrrtttt ****uuuunnnnkkkknnnnoooowwwwnnnn____lllleeeennnnggggtttthhhh,
  22.           uuuunnnnssssiiiiggggnnnneeeedddd cccchhhhaaaarrrr ********uuuunnnnkkkknnnnoooowwwwnnnn____vvvvaaaalllluuuueeee);
  23.  
  24.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  25.           This page documents Motif 2.1.
  26.  
  27.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.           This function is obsolete and exists for compatibility with
  29.           previous releases. It is replaced by XXXXmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttTTTTrrrriiiipppplllleeee.
  30.           XXXXmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttCCCCoooommmmppppoooonnnneeeennnnttttreturns the type and value of the
  31.           next component in the compound string identified by _c_o_n_t_e_x_t.
  32.           Components are returned one at a time. On return, only some
  33.           output parameters will be valid; which ones can be
  34.           determined by examining the returned component type.  The
  35.           following table describes the valid returns for each
  36.           component type.
  37.           VVVVaaaalllliiiidddd FFFFiiiieeeellllddddssss           CCCCoooommmmppppoooonnnneeeennnntttt TTTTyyyyppppeeee
  38.           _t_a_g                    _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__L_O_C_A_L_E,
  39.                                  _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__T_A_G
  40.           _t_e_x_t                   _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__L_O_C_A_L_E__T_E_X_T,
  41.                                  _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__T_E_X_T,
  42.                                  _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__W_I_D_E_C_H_A_R__T_E_X_T
  43.           _d_i_r_e_c_t_i_o_n              XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG____CCCCOOOOMMMMPPPPOOOONNNNEEEENNNNTTTT____DDDDIIIIRRRREEEECCCCTTTTIIIIOOOONNNN
  44.           _u_n_k_n_o_w_n__t_a_g,           _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__L_A_Y_O_U_T__P_O_P,
  45.           _u_n_k_n_o_w_n__l_e_n_g_t_h,        _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__L_A_Y_O_U_T__P_U_S_H,
  46.           _u_n_k_n_o_w_n__v_a_l_u_e          _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__T_A_B,
  47.                                  _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__R_E_N_D_I_T_I_O_N__B_E_G_I_N,
  48.                                  _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__R_E_N_D_I_T_I_O_N__E_N_D
  49.           _n_o _v_a_l_i_d _f_i_e_l_d         _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__S_E_P_A_R_A_T_O_R,
  50.                                  _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__E_N_D,
  51.                                  _X_m_S_T_R_I_N_G__C_O_M_P_O_N_E_N_T__U_N_K_N_O_W_N
  52.  
  53.           Note that several components produce a return value of
  54.           XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG____CCCCOOOOMMMMPPPPOOOONNNNEEEENNNNTTTT____UUUUNNNNKKKKNNNNOOOOWWWWNNNN. The data returned by these
  55.           components is returned in the _u_n_k_n_o_w_n__t_a_g, _u_n_k_n_o_w_n__l_e_n_g_t_h,
  56.           and _u_n_k_n_o_w_n__v_a_l_u_e fields. This apparent inconsistency is
  57.           designed to accomodate older applications that may not be
  58.           equipped to handle the newer component types of Motif
  59.           version 2.0 and beyond.  Consequently, the use of this
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttCCCCoooommmmppppoooonnnneeeennnntttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttCCCCoooommmmppppoooonnnneeeennnntttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           procedure is not recommended. Instead, use the
  75.           XXXXmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttTTTTrrrriiiipppplllleeee procedure, which provides all the
  76.           functionality of XXXXmmmmSSSSttttrrrriiiinnnnggggGGGGeeeettttNNNNeeeexxxxttttCCCCoooommmmppppoooonnnneeeennnntttt, and is fully
  77.           compatible with the newer component types.
  78.  
  79.           If the function return value is
  80.           XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG____CCCCOOOOMMMMPPPPOOOONNNNEEEENNNNTTTT____LLLLOOOOCCCCAAAALLLLEEEE____TTTTEEEEXXXXTTTT or XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG____CCCCOOOOMMMMPPPPOOOONNNNEEEENNNNTTTT____TTTTEEEEXXXXTTTT,
  81.           the the function allocates space to hold the returned _t_e_x_t.
  82.           If the function return value is
  83.           XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG____CCCCOOOOMMMMPPPPOOOONNNNEEEENNNNTTTT____FFFFOOOONNNNTTTTLLLLIIIISSSSTTTT____EEEELLLLEEEEMMMMEEEENNNNTTTT____TTTTAAAAGGGG, or
  84.           XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG____CCCCOOOOMMMMPPPPOOOONNNNEEEENNNNTTTT____TTTTAAAAGGGG, then the function allocates space to
  85.           hold the returned _t_a_g.  The application is responsible for
  86.           managing the allocated space.  The application can recover
  87.           the allocated space by calling XXXXttttFFFFrrrreeeeeeee.
  88.  
  89.           _c_o_n_t_e_x_t   Specifies the string context structure that was
  90.                     allocated by the XXXXmmmmSSSSttttrrrriiiinnnnggggIIIInnnniiiittttCCCCoooonnnntttteeeexxxxtttt function.
  91.  
  92.           _t_e_x_t      Specifies a pointer to a NULL terminated string.
  93.  
  94.           _t_a_g       Specifies a pointer to the tag component
  95.                     associated with the text. The value
  96.                     XXXXmmmmFFFFOOOONNNNTTTTLLLLIIIISSSSTTTT____DDDDEEEEFFFFAAAAUUUULLLLTTTT____TTTTAAAAGGGG identifies a locale text
  97.                     segment.
  98.  
  99.           _d_i_r_e_c_t_i_o_n Specifies a pointer to the direction of the text.
  100.  
  101.           _u_n_k_n_o_w_n__t_a_g
  102.                     Specifies a pointer to the tag of an unknown
  103.                     component.
  104.  
  105.           _u_n_k_n_o_w_n__l_e_n_g_t_h
  106.                     Specifies a pointer to the length of an unknown
  107.                     component.
  108.  
  109.           _u_n_k_n_o_w_n__v_a_l_u_e
  110.                     Specifies a pointer to the value of an unknown
  111.                     component.
  112.  
  113.      RRRREEEETTTTUUUURRRRNNNN
  114.           Returns the type of component found.  Refer to the
  115.           XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCoooommmmppppoooonnnneeeennnnttttTTTTyyyyppppeeee(3) reference page for a list of
  116.           component types.
  117.  
  118.      RRRREEEELLLLAAAATTTTEEEEDDDD
  119.           XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCoooommmmppppoooonnnneeeennnnttttTTTTyyyyppppeeee(3), XXXXmmmmSSSSttttrrrriiiinnnnggggCCCCrrrreeeeaaaatttteeee(3), and
  120.           XXXXmmmmSSSSttttrrrriiiinnnnggggIIIInnnniiiittttCCCCoooonnnntttteeeexxxxtttt(3).
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.